docs: update release process guide - #4502
Conversation
Document the separate PyPI workflow, remove obsolete per-agent ZIP steps, and add recovery guidance for incomplete releases. Closes github#4501 Assisted-by: Codex (model: GPT-5, autonomous)
mnriem
added
the
triage-nice-to-have
There was a problem hiding this comment.
🟡 Changes recommended
Recovery coverage is incomplete, and version-mismatch guidance conflicts with the documented development bump.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates release documentation to reflect the current GitHub Release and PyPI workflows.
Changes:
- Documents the three-workflow release process.
- Adds development-version bump details.
- Adds incomplete-release recovery guidance.
File summaries
| File | Description |
|---|---|
.github/workflows/RELEASE-PROCESS.md |
Aligns release instructions with current workflows. |
Review details
Suppressed comments (1)
.github/workflows/RELEASE-PROCESS.md:202
- The recovery table does not satisfy #4501's requested completion model: it never covers the release branch/PR and collapses the wheel and sdist into a single “PyPI version” or “some distributions” state. Maintainers therefore still cannot verify and recover each of the four outputs independently. Add explicit status/recovery entries (or columns) for the release branch/tag, GitHub Release, wheel, and sdist.
| State | Recovery |
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| 7. Commit changes | ||
| 8. Push branch and tag | ||
| 9. Open PR to merge version bump into `main` | ||
| 9. Bump `pyproject.toml` to the next patch development version and push the branch |
|
Thanks @philo-x — useful refresh of the release docs. One open item from the review before this lands: documenting the development-version bump makes the existing "Version Mismatch" section (lines ~217–222) contradictory — once the release PR merges, |
Assisted-by: Codex (model: GPT-6, autonomous)
|
Posted on behalf of @philo-x by Codex; this review follow-up was authored and validated by the agent. Commit 4dae159 clarifies that the release tag must match the package version at the tagged commit, while the merged release PR intentionally advances main to the next patch development version. It also adds recovery guidance for an incomplete release branch/PR and separate missing-wheel and missing-sdist states, including the limits of rerunning the current PyPI workflow after a partial upload. Validation passed: git diff --check and markdownlint-cli2 v0.23.2 on .github/workflows/RELEASE-PROCESS.md (0 issues, using the locally cached CLI). No workflow behavior changed. @mnriem, please review this follow-up. |
Assisted-by: Codex (autonomous)
|
Posted on behalf of @philo-x by Codex; this follow-up and its validation were produced by the agent. Commit Validation passed: @mnriem, please review the updated documentation. |
Description
RELEASE-PROCESS.mdstill described the removed per-agent ZIP pipeline and omitted the manual PyPI publisher. This updates the guide to match the current three-workflow release process, documents the development-version bump, and adds recovery guidance for independently incomplete GitHub and PyPI publication.Closes #4501
Testing
git diff --checknpx --yes markdownlint-cli2 '.github/workflows/RELEASE-PROCESS.md'(0 issues)AI Disclosure
Codex (model: GPT-5) inspected the current workflows, drafted the documentation update, and ran validation on behalf of @philo-x. This PR is being submitted by Codex autonomously on behalf of @philo-x.